MMhelper quick-start

Getting started with MMhelper

We recommend that you print this document, or use the printed 'Quick Start' document that came with the CD.

HOW TO create a new help project

Notice the example given tutorial for the calculator application in blue.
Open the MMhelper help editor (its default location is 'Start' menu, programs\MMhelper.
 
A. Selecting the application you want to create MMhelper help project for.
1. Select 'New project' from the 'File' menu. 
2. Select the software that you want to create help for (your "target" software).
    (e.g.= open the 'Accessories' folder and select calculator application.
     Notice to make sure that the calculator is opened in 'scientific' view) .
B. Capturing the desired components of the target application.
1. In the 'Capture Key Select' dialog, define the key, which would trigger the capturing process.
    (e.g.= in this case don't change the default option.)
2. Close the 'Tip' box.  
3. In the 'Builder-Control Panel' (placed above the main window of the MMhelper) click the 'Capture the pointed object' button (the red circle(. The target application will be launched.
4. Place the mouse cursor over the component you want to capture.
    (e.g.= place the mouse cursor over the 'bin' button.)
5. Click once on the right mouse button or use the Hotkey according to the configuration made in the 'Capture Key Select' window.
     The captured component will be encircle by flickering red and green frame,
     So you can be sure that you have captured the right component.
6.	The MMhelper help builder will become your active window. In the 'Application Tree Window' (left side of the screen) notice the node that was added, that represents the component you have captured. 

C. Creating help contents that will be attached to the target application 
     components.
1. In the 'Content list Window' (right side of the screen) click on the 'Add content' icon (first icon from left). The 'New Help Topic Wizard' will be opened.
2. From the main screen of the wizard select your desired type of help topic,
     then press 'Next'. (e.g.= choose 'Ballon', to create a simple tooltip.)
3. In the edit box that was opened enter the text you want to popup in a balloon.
     Press 'Next'. (e.g.= enter 'my help'  in the edit box.)
Note: in case 'External' or 'Multimedia' types were selected, you will need to choose external files as your contents.
4. In the third screen of the wizard, at the edit box, under the title 'Enter Topic Name', you can see that the MMhelper has already set the value of the help topic as the default name, but you can change it as you please. Press 'Finish'.

D. Attaching the help topics to the desired nodes.
After you have captured the target application and created your help topics, you now need to attach the help contents to the components of the target application. 
You can accomplish this task by simply dragging a help topic onto the desired node within the 'Application Tree'. Press with left-mouse button on the help topic and drag it to the desired node, when the desired node is bold, release the left-mouse-button.
(e.g.= drag 'My help' balloon onto the 'Bin' button node.)
Two new nodes will appear in the Application Tree, beneath the desired component's node; the node 'All', and beneath that- the help content you have attached. 

E. Running the new help project. 
(See the help system the way the end-user will.)
1.	Save your work (the default name for the project is the name of the application) and exit the MMhelper help builder.

2. Open the MMhelper runtime engine (its default location is at the 'Start' menu- programs\ MMhelper\ MMhelper runtime engine). The 'MMhelper runtime engine' icon will appear at the right buttom of your screen next to the clock.
3.	Now start the target software. (e.g.= start the 'calculator' from Start\Programs\accessories). Move the mouse cursor over the component that you've previously attached help contents to, and test the help system. (e.g.= the balloon 'My help' will be launched when your mouse cursor is over the 'Bin' button).
4. The MMhelper runtime engine has a tray menu which you can use in order to close or disable it. The tray menu can be activated by right-mouse-click on the MMhelper icon at the lower right corner of the desktop. 

For further assistance please refer to our online guide www.esmmi.com \support  or contact our support department at: support@esmmi.com.